home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / gnu / sed-2_00.lha / sed-2.00 / ABOUT.RX next >
Text File  |  1993-07-15  |  2KB  |  36 lines
  1.  
  2. Rx is found in the files `rx.h' and `rx.c'.  It is an upward
  3. compatable replacement for GNU regex.  If you want to try GNU Rx in
  4. your own application, the documentation for GNU _regex_ will tell you
  5. how.
  6.  
  7. Notes:
  8.  
  9. * This release of Rx is not quite ready for use in GNU Emacs.
  10.  
  11. * When initializing a variable of type `struct re_pattern_buf',
  12.   use `bzero' or an equivelent function first.  Some older code
  13.   might try to work by assigning 0 to specific fields defined in 
  14.   GNU regex.  All of those fields still exist, but new fields have
  15.   been added (and more may be in the future).
  16.  
  17. * Rx keeps a cache of information about patterns.  The size of this cache 
  18.   may effect performance.  The default size should be large enough for
  19.   most applications.  However, for a program like `sed', there is no reason
  20.   to keep the cache small.  Such programs might want to assign a large 
  21.   number (say, 10000) to the global variable `rx_cache_bound' before
  22.   calling other rx functions.
  23.  
  24.   Finer shades of allocation control are possible, but there is no 
  25.   documentation to describe how, yet.
  26.  
  27. * Like GNU regex, Rx can return the positions of parenthesized subexpressions
  28.   in a match (`registers').  Rx adds a new field to an `struct re_pattern_buf'
  29.   called `syntax_parens'.  That field may be used to tell Rx to ignore some
  30.   parentheses; i.e.: to treat them as purely syntactic and not return
  31.   the location of the subexpression they surround.  Using this field is 
  32.   optional, but may speed up matches.  Full documentation for this feature
  33.   is lacking, but adventurous users can find an example of its use in `sed.c'
  34.   and can have questions answered by writing to the bug address.
  35.  
  36.